Store adapter — Adobe Business Catalyst¶
The adapter
object contains properties for connecting to the Adobe Business Catalyst API.
Parent object: a store with property "platform" : "business_catalyst"
Required properties¶
The following adapter
properties are required for Adobe Business Catalyst stores.
password
¶
Property | password |
---|---|
Name | API User Password |
Data type | string |
Required? | Yes |
secure_domain
¶
Property | secure_domain |
---|---|
Name | API Secure Domain |
Data type | string |
Requirements | Must be valid URL |
Required? | Yes |
site_id
¶
Property | site_id |
---|---|
Name | Unique Site ID |
Data type | string |
Required? | Yes |
username
¶
Property | username |
---|---|
Name | API User Email Address |
Data type | string |
Required? | Yes |
Optional properties¶
The following adapter
properties are optional for Adobe Business Catalyst stores.
tracking_crm_field_name
¶
Property | tracking_crm_field_name |
---|---|
Name | Tracking Number Field Name |
Description | Custom field used for the shipment tracking number |
Data type | string |
Example¶
Example: create a new Adobe Business Catalyst store
curl -X POST \
-H "Authorization: Bearer $JWT_TOKEN" \
-H "Content-Type: application/json" \
https://api.getdropstream.com/stores \
-d @- <<EOF
{ "customer_id": "3775",
"name": "Your Business Catalyst Store",
"platform": "business_catalyst",
"adapter": {
"secure_domain": "https://www.example.com",
"site_id": "abc123",
"username": "abc123",
"password": "abc123",
"tracking_crm_field_name": "abc123"
}
}
EOF
For details about this request type, see: Create a new store.